/*
 * Copyright the original author or authors.
 * 
 * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.mozilla.org/MPL/MPL-1.1.html
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import com.bourre.structures.Range;
import com.kairos.engine.RTEvent;
import com.kairos.utils.monitor.AbstractMonitorField;

/**
 * Client screen size field for {@code com.kairos.utils.Monitor}.
 * 
 * @author Romain Ecarnot
 */
class com.kairos.utils.monitor.ScreenSizeField extends AbstractMonitorField
{
	//-------------------------------------------------------------------------
	// Private properties
	//-------------------------------------------------------------------------
	
	private var _nWidth : Number;
	private var _nHeight : Number;
	
		
	//-------------------------------------------------------------------------
	// Public API
	//-------------------------------------------------------------------------
		
	public function ScreenSizeField( col : Number )
	{
		super( 'Screen size', 0, '', col );
	}
	
	/**
	 * Overrides.
	 * <p>Screen size field is not displayed as curve.
	 * 
	 * @return {@code false}
	 */
	public function isCurve( ) : Boolean
	{
		return false;
	}
	
	/**
	 * Returns client screen size.
	 * 
	 * @return {@code String} of the formatted value.
	 */
	public function getFormattedValue( ) : String
	{
		return _nWidth + "x" + _nHeight;
	}
	
	/**
	 * Overrides.
	 * <p>No difference available here.
	 * 
	 * @returns {@code null}
	 */
	public function getDifference( ) : Range
	{
		return null;
	}
	
	/**
	 * Called by the {@code com.kairos.utils.Monitor} on each frame of the
	 * animation.
	 * 
	 * @param 	e	The RTEvent dispatched by the <code>Kairos RTBeacon</code>
	 */
	public function registerValue ( e : RTEvent ) : Void
	{
		_nWidth = System.capabilities.screenResolutionX;
		_nHeight = System.capabilities.screenResolutionY;
	}
	
}